Repository navigation
docs: a real usage site (#89) - #63
Merged
Merged
Conversation
docs/usage was a single "not released yet" page. It is now a documentation site: getting started (installation, a quick start on the sample list screen), how the layers fit together, one page per module, guides (testing, a production setup, paging with Camouflage), a changelog, an FAQ and links, with offline search. Every sample is real code. A `// sample: <path>#<region>` block is copied from a compiled or analyzed file in the libraries by scripts/sync_samples.py, which also fails on a block that has drifted. The language switch now drives every Kotlin/Dart code group (the scaffold's LangTabs ignored it), and the home page language menu is no longer clipped: both fixes are Camouflage's (srctool/camouflage#69). Closes srctool/sinew-kotlin#89 Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/usagewas a single "not released yet" page. It is a documentation site now.// sample: <path>#<region>block is copied from a compiled or analyzed file in the libraries byscripts/sync_samples.py, which also fails on a block that has drifted. The Kotlin ones come fromkotlin-lib/sample/docs, a module CI compiles and tests.LangTabsignored it, so the switch changed nothing on a page), and the home page language menu is no longer clipped.Testing
npm run buildonBrokenLinks: 'throw'sync_samples.py --checkFor review
detect-changesreports critical risk and 422 affected processes. It's a false positive. The staged change is the site (pages, a script, three UI components, a config). The one symbol that links to flows is thethemesproperty indocusaurus.config.ts, which name-matches unrelated code symbols calledthemes; the graph is also stale (last indexed at56113d8). No library runtime code is in this PR.kotlin-lib/...,dart-lib/...) resolve through the submodules. Until Dependabot bumps the submodule pointers after the library PRs merge,--checkcan't find the new files in CI, so I haven't added it to CI yet.Closes srctool/sinew-kotlin#89
Pairs with the samples in srctool/sinew-kotlin (
docs/89-doc-samples) and the region markers in srctool/sinew-dart (docs/86-dart-doc-samples).🤖 Generated with Claude Code